Skip to content

Replace Sphinx docs with MkDocs Material#272

Open
anatoly-scherbakov wants to merge 49 commits into
masterfrom
docs/mkdocs-material
Open

Replace Sphinx docs with MkDocs Material#272
anatoly-scherbakov wants to merge 49 commits into
masterfrom
docs/mkdocs-material

Conversation

@anatoly-scherbakov

@anatoly-scherbakov anatoly-scherbakov commented Jun 1, 2026

Copy link
Copy Markdown
Collaborator

Fixes #259. Documentation at https://digitalbazaar.github.io/pyld/

Summary

  • replace the old Sphinx docs setup with MkDocs Material
  • add user-facing docs pages for installation, examples, document loaders, and manual API reference
  • add GitHub Pages deployment workflow and local make serve target

Validation

  • .venv/bin/mkdocs build --strict

Comment thread .github/workflows/docs.yaml Fixed
Comment thread .github/workflows/docs.yaml Fixed
Comment thread .github/workflows/docs.yaml Fixed
Comment thread .github/workflows/docs.yaml Fixed
@github-actions

github-actions Bot commented Jun 1, 2026

Copy link
Copy Markdown

@mielvds mielvds left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very nice and also long overdue! I added some comments, nothing major. I can think of many things to add ofc., but I'll leave these for upcoming PR's. It would be nice to include this in the next release.

Comment thread Makefile Outdated
Comment thread docs/requirements.txt Outdated
Comment thread .gitignore
Comment thread docs/index.rst
Comment thread docs/index.md Outdated
Comment thread docs/index.md Outdated
Comment thread docs/index.md Outdated
Comment thread docs/index.md Outdated
Comment thread docs/api-reference.md Outdated
Comment thread docs/document-loaders.md
@anatoly-scherbakov

Copy link
Copy Markdown
Collaborator Author

@mielvds thanks for the review! I haven't yet had a chance to get back to this PR but I will shortly (probably on the weekend)

@mielvds

mielvds commented Jun 10, 2026

Copy link
Copy Markdown
Collaborator

NP! The markdown conversion is now merged, but I totally forgot to add a link to the documentation in README.md. Maybe add this as well :)
After this PR is merged, I'll release 3.1.0

anatoly-scherbakov and others added 28 commits June 13, 2026 21:36
Co-authored-by: Anatoly Scherbakov <altaisoft@gmail.com>
Co-authored-by: Anatoly Scherbakov <altaisoft@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

More extensive documentation

3 participants